<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
	Universal Media Server, for streaming any media to DLNA
	compatible renderers based on the http://www.ps3mediaserver.org.
	Copyright (C) 2012 UMS developers.
	
	This program is a free software; you can redistribute it and/or
	modify it under the terms of the GNU General Public License
	as published by the Free Software Foundation; version 2
	of the License only.
	
	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.
	
	You should have received a copy of the GNU General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-->
<html>
	<head>
		<meta charset="UTF-8">
		<title>Command line arguments</title>
		<link href="css/style.css" rel="stylesheet" type="text/css" />
	</head>
	<body>
		<h1>Command line arguments</h1>
		
		<p>UMS can be launched with command line arguments. These arguments can either be used from the command line directly, be used from scripts or be used from shortcuts. The <code>Universal Media Server (Select Profile)</code> shortcut made by the Universal Media Server Windows installer is an example of this (launched with the <code>profiles</code> argument). <abbr>UMS</abbr> will be used as an abbreviation for Universal Media Server in the rest of this document.</p>
		
		<h2>Arguments</h2>
		
		<ul>
			<li><code>headless</code> - This starts UMS without a <a href="https://en.wikipedia.org/wiki/Graphical_user_interface">GUI</a>. It can be useful for running UMS in the background without any user interface, but be aware that under Windows there is no other way than using the task manager to stop UMS again. This option in most useful under Linux, where you can stop UMS again simply by pressing <code>Ctrl + c</code>. If no graphical environment is available, UMS will automatically start in this mode.</li>
			<li><code>console</code> - This is identical to <code>headless</code>.</li>
			<li><code>noconsole</code> - This will refuse UMS to start in headless/console mode if it cannot initialize the <a href="https://en.wikipedia.org/wiki/Graphical_user_interface">GUI</a>.</li>
			<li><code>nativelook</code> - This only works under Linux and attempts to use the graphical environment's native look.</li>
			<li><code>scrollbars</code> - This creates horizontal and vertical scroll bars in UMS' main windows, allowing the window to be smaller than UMS is designed for. It can be useful on low resolution desktops.</li>
			<li><code>profiles</code> - This will launch the <code>Profile Chooser</code> during UMS startup, allowing you to choose a profile file or folder for UMS to use.</li>
			<li><code>profile=&lt;path&gt;</code> or <code>profile:&lt;path&gt;</code> - This will start UMS with the profile from the file or folder specified in <code>&lt;path&gt;</code>. This is mostly useful for starting a specific profile from a script or shortcut.</li>
			<li><code>trace</code> - This will start UMS in &quot;forced trace&quot; mode, where the log level is forced to &lt;trace&gt; level regardless of the log level specified in the profile. It's not possible to change log level in this mode.</li>
		</ul>
		
		To be able to use the command line arguments on Windows, follow this syntax:
		
		<h3>Windows</h3>
		<code>UMS.exe argument 1 argument 2 ... argument X</code>
		
		<h3>Linux</h3>
		<code>./UMS.sh argument 1 argument 2 ... argument X</code>
		
		<h3>Mac OS</h3>
		<code>open -a "Universal Media Server" --args argument1 argument2 ...</code>
		
	<!--  Navigation -->
	<hr />
	<ul>
		<li>Next: <a href="plugins.html">Plugins</a>
		</li>
		<li>Previous: <a href="coreavc.html">CoreAVC</a>
		</li>
		<li>Top: <a href="index.html">Help</a>
		</li>
	</ul>
	</body>
</html>
